home *** CD-ROM | disk | FTP | other *** search
/ Aminet 33 / Aminet 33 - October 1999.iso / Aminet / dev / misc / vahunz.readme < prev    next >
Encoding:
Text File  |  1999-09-06  |  7.3 KB  |  197 lines
  1. Short:    Make source code un-/more legible
  2. Author:   Thomas Aglassinger <agi@giga.or.at>
  3. Uploader: Thomas Aglassinger <agi@giga.or.at>
  4. Version:  1.6
  5. Type:     dev/misc
  6. Requires: AmigaOS 2.04, 68020, 2MB
  7. Kurz:     Macht Quellcode un-/besser lesbar
  8.  
  9. TITLE
  10.  
  11.   vahunz - Make source code un-/more legible.
  12.  
  13. VERSION 
  14.  
  15.   1.6
  16.  
  17. AUTHOR
  18.  
  19.   Thomas Aglassinger <agi@giga.or.at>
  20.  
  21. DESCRIPTION
  22.  
  23.   Vahunz is a CLI-based replace command that can replace many words
  24.   across several files with only one invocation.
  25.  
  26.   Normally the target words will be created randomly, turning
  27.   meaningful names into unlegible garbage. For example, a function
  28.   name like read_input_file() could be replaced by g7B() or something
  29.   as useless. Additionally, comments and indention can be removed.
  30.  
  31.   As an option, you can specify specific substitutes, so Vahunz can
  32.   also be applied in a non-destructive manner. This can be used to
  33.   replace inconsistent, too short or unlegible names by something more
  34.   meaningful. Among programmers, this process is known as "The Great
  35.   Renaming".
  36.  
  37.   An Amiga Installer script acting as frontend to the CLI command is
  38.   included, so most tasks can be performed without having to deal with
  39.   cryptic command line options.
  40.  
  41. FEATURES
  42.  
  43.   - Stores less/more legible copy in a different directory
  44.   - Supports C, C++ and Java
  45.   - Auto-detects programming language
  46.   - New names since last run are easy to see
  47.   - Names can easily be declared to be modified or left untouched;
  48.     for example, it makes no sense to replace printf().
  49.   - Words being part of comments or string constants are not replaced
  50.   - Fast, as internally names are stored in an AVL-tree
  51.   - Several options to back-trace problems in vahunzed code
  52.   - Includes a set of standard dictionaries for various environments
  53.   - Includes source code (vahunzed ANSI C)
  54.  
  55. NEW FEATURES
  56.  
  57.   - Fixed some minor quirks
  58.   - Improved wording of error messages
  59.   - Added keywords for c9x (ISO C) and C++
  60.  
  61. SPECIAL REQUIREMENTS
  62.  
  63.   AmigaOS 2.04, 2MB of regular memory, 68020
  64.  
  65. AVAILABILITY
  66.  
  67.   - Every Aminet-mirror, file "dev/misc/vahunz.lha", for example:
  68.  
  69.     ftp://wuarchive.wustl.edu/pub/aminet/dev/misc/vahunz.lha
  70.  
  71.   - http://www.giga.or.at/~agi/vahunz/
  72.  
  73. PRICE
  74.  
  75.   Freeware.
  76.  
  77. DISTRIBUTABILITY
  78.  
  79.   Freely distributable as long the conditions described in the manual
  80.   are met.
  81.  
  82. EXAMPLE
  83.  
  84.   For example, one might have a code excerpt like this:
  85.  
  86.     int main(void)
  87.     {
  88.         while (sepp_age < 83)
  89.         {
  90.             grow_older(sepp_name, &sepp_age);
  91.             print_sepp();
  92.         }
  93.         printf("\n%s died.\n", sepp_name);
  94.         exit(EXIT_SUCCESS);
  95.     }
  96.  
  97.   After vahunzing, this is what it might look like:
  98.  
  99.     int main(void)
  100.     {
  101.     while (g8B < 83)
  102.     {
  103.     z3V(v6Z, &g8B);
  104.     f4V();
  105.     }
  106.     printf("\n%s died.\n", v6Z);
  107.     exit(EXIT_SUCCESS);
  108.     }
  109.  
  110.   As you can see, the internal names have been garbled, but the
  111.   symbols of the standard library are preserved.
  112.  
  113.  
  114. ============================= Archive contents =============================
  115.  
  116. Original  Packed Ratio    Date     Time    Name
  117. -------- ------- ----- --------- --------  -------------
  118.      628     277 55.8% 06-Sep-98 16:34:50  vahunz.info
  119.   208854   69468 66.7% 17-Sep-98 14:42:12 +amiga.ignore
  120.     5325    2313 56.5% 17-Sep-98 14:41:48 +ansi.ignore
  121.        1       1  0.0% 04-Sep-98 13:09:34 +empty.ignore
  122.   151894   47739 68.5% 16-Aug-99 15:54:18 +java.ignore
  123.   187597   65700 64.9% 17-Sep-98 14:42:32 +unix.ignore
  124.      204     116 43.1% 09-Feb-98 08:37:14 +Makefile
  125.      367     236 35.6% 09-Feb-98 08:38:44 +older.c
  126.      165     118 28.4% 09-Feb-98 08:34:48 +older.h
  127.      781     413 47.1% 14-Feb-98 20:13:40 +sepp.c
  128.      628     277 55.8% 06-Sep-98 16:34:42 +manual.info
  129.     5775    2600 54.9% 16-Aug-99 21:52:32 +beyond.html
  130.     6506    2689 58.6% 16-Aug-99 21:52:10 +dictionary.html
  131.     7944    3300 58.4% 16-Aug-99 21:51:46 +future.html
  132.      138     138  0.0% 14-Jan-96 17:27:46 +back.gif
  133.      190     190  0.0% 14-Jan-96 17:20:08 +copy.gif
  134.      170     170  0.0% 14-Jan-96 17:14:34 +index.gif
  135.      176     176  0.0% 14-Jan-96 17:14:44 +main.gif
  136.      189     189  0.0% 14-Jan-96 17:15:02 +next.gif
  137.      168     168  0.0% 14-Jan-96 17:28:12 +noback.gif
  138.      211     211  0.0% 14-Jan-96 17:20:36 +nocopy.gif
  139.      200     200  0.0% 14-Jan-96 17:15:28 +noindex.gif
  140.      201     201  0.0% 11-Jan-98 16:39:54 +nomain.gif
  141.      212     212  0.0% 14-Jan-96 17:15:52 +nonext.gif
  142.      213     213  0.0% 15-Jul-96 23:44:28 +noprev.gif
  143.      188     188  0.0% 14-Jan-96 17:16:08 +prev.gif
  144.      141     141  0.0% 04-Nov-95 02:20:36 +up.gif
  145.      981     981  0.0% 21-Feb-98 01:00:48 +vahunz-now.gif
  146.     1553    1553  0.0% 19-Apr-98 18:40:04 +vahunz.gif
  147.     2765    2765  0.0% 25-Sep-98 08:07:24 +verhunz.gif
  148.     4472    1896 57.6% 16-Aug-99 21:51:02 +index.html
  149.      481     256 46.7% 06-Sep-98 16:34:38 +index.html.info
  150.     5867    2545 56.6% 16-Aug-99 21:52:26 +inside.html
  151.     2592    1164 55.0% 16-Aug-99 21:52:22 +keyctionary.html
  152.     3484    1676 51.8% 16-Aug-99 21:51:30 +legal.html
  153.     5507    2423 56.0% 16-Aug-99 21:51:26 +overview.html
  154.     3416    1677 50.9% 16-Aug-99 21:51:38 +problems.html
  155.    12197    4749 61.0% 16-Aug-99 21:51:16 +reference.html
  156.     1534     750 51.1% 16-Aug-99 21:51:42 +requirements.html
  157.     2945    1383 53.0% 16-Aug-99 21:52:36 +source.html
  158.     2276    1068 53.0% 16-Aug-99 21:51:34 +support.html
  159.     2431    1166 52.0% 17-Sep-98 14:18:40 +tschak.html
  160.    10868    4337 60.0% 16-Aug-99 21:51:20 +tutorial.html
  161.     2056     964 53.1% 16-Aug-99 21:51:54 +use-case-1.html
  162.     4923    2071 57.9% 16-Aug-99 21:51:58 +use-case-2.html
  163.     2913    1349 53.6% 16-Aug-99 21:52:02 +use-case-3.html
  164.     3469    1687 51.3% 16-Aug-99 21:52:06 +use-case-4.html
  165.     3007    1400 53.4% 16-Aug-99 21:52:16 +use-case-5.html
  166.     2972    1374 53.7% 16-Aug-99 21:52:18 +use-case-6.html
  167.     1195     343 71.2% 19-Apr-98 16:08:14 +compile
  168.    25256    9275 63.2% 24-Oct-97 04:36:18 +COPYING.LIB
  169.     5677    1758 69.0% 17-Aug-99 03:41:04 +ubi_AVLtree.c
  170.     1981     858 56.6% 17-Aug-99 03:41:04 +ubi_AVLtree.h
  171.     6382    2291 64.1% 17-Aug-99 03:41:06 +ubi_BinTree.c
  172.     3152    1302 58.6% 17-Aug-99 03:41:06 +ubi_BinTree.h
  173.     6923    2058 70.2% 17-Aug-99 03:41:06 +expstr.c
  174.     2562     919 64.1% 17-Aug-99 03:41:08 +expstr.h
  175.     1105     495 55.2% 17-Aug-99 03:41:08 +udebug.h
  176.     8107    2883 64.4% 17-Aug-99 03:41:08 +umemory.c
  177.     2325     883 62.0% 17-Aug-99 03:41:10 +umemory.h
  178.     3414    1400 58.9% 17-Aug-99 03:41:10 +ustring.c
  179.     1606     712 55.6% 17-Aug-99 03:41:10 +ustring.h
  180.     1953     771 60.5% 17-Aug-99 03:41:12 +utypes.h
  181.     2236     924 58.6% 17-Aug-99 03:41:12 +keywords.c
  182.    25148    8754 65.1% 17-Aug-99 03:41:14 +vahunz.c
  183.     1046     498 52.3% 17-Aug-99 03:41:14 +vahunz_rev.h
  184.     3860    2448 36.5% 16-Sep-98 03:33:02 +blank-to-hyphen
  185.      466     253 45.7% 16-Sep-98 03:32:52 +blank-to-hyphen.c
  186.      886     397 55.1% 02-Sep-98 08:08:24 +def_vahunz.info
  187.    21296   12188 42.7% 13-Aug-99 21:45:42 +scan_javadoc
  188.     2035     806 60.3% 16-Aug-99 15:56:58 +scan_javadoc.e
  189.       42      39  7.1% 12-Aug-99 16:48:56 +SCOPTIONS
  190.    41572   23867 42.5% 16-Aug-99 22:05:22 +vahunz
  191.    31784    7522 76.3% 16-Aug-99 21:43:08 +Vahunz-Tschak
  192.      930     430 53.7% 16-Sep-98 03:18:08 +Vahunz-Tschak.info
  193.     2688    1420 47.1% 17-Aug-99 03:40:44 +vahunz.readme
  194.      496     267 46.1% 04-Sep-98 13:29:12 +vahunz.readme.info
  195. -------- ------- ----- --------- --------
  196.   867898  322639 62.8% 17-Aug-99 18:54:16   77 files
  197.